Get

Function

This API is used to get parameter for AI > Setup > Heat Map page.

Request Message

Table 1

ParameterRangeTypeDescription
channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…” WIFI_CH1x”
The number of channels depends on the capabilities of the device.		string arrayEach array bit represents a channel with a string.
DVR/NVR need;
IPC only use CH1
page_type“ChannelConfig”,
“AlarmConfig”		stringThe data used to distinguish whether it is a channel configuration page or an alarm configuration page

Sample:

POST API/AI/Setup/HeatMap/Get HTTP/1.1

{
    "version": "1.0",
    "data": {"page_type": "ChannelConfig"}
}

Response Message

Parameter Description

Table 2

ParameterRangeTypeDescription
channel_infoJSON objectSingle Channel Information JSON show as follow Table Table 3
channel_maxintMaximum number of channels

Table 3

ParameterRangeTypeDescription
CH1Json ObjectJSON show as follow Table Table 4
…Json Object
IP_CH1Json Object
…Json Object
WIFI_CH1Json Object
…Json Object

Table 4

ParameterRangeTypeDescription
status"Offline","Online"，“Nonsupport”stringChannel online status, only for digital channels.
Note: When the channel is online, there is no such field
switchtrue, falseboolSwitch, false: close true: open
rule_infoObjectInformation JSON show as follow Table Table 5
schedule_enableboolSchedule mode
ptz_operation_supportbool(Ball machine use)Supports the ptz operation

Table 5

ParameterRangeTypeDescription
rule_number1ObjectRule number 1,information JSON show as follow Table Table 6

Table 6

ParameterRangeTypeDescription
rule_switchboolRule switch
rule_lineObjectRectangle,Information JSON show as follow Table Table 7
point_num[min:max]arrayThe number of points drawn in the area, minimum 3 points (min), maximum 8 points (max)

Table 7

ParameterRangeTypeDescription
x10-704shortx1 coordinate points
y10-576shorty1 coordinate points
x20-704shortx2 coordinate points
y20-576shorty2 coordinate points
x30-704shortx3 coordinate points
y30-576shorty3 coordinate points
x40-704shortx4 coordinate points
y40-576shorty4 coordinate points
x50-704shortx5 coordinate points
y50-576shorty5 coordinate points
x60-704shortx6 coordinate points
y60-576shorty6 coordinate points
x70-704shortx7 coordinate points
y70-576shorty7 coordinate points
x80-704shortx8 coordinate points
y80-576shorty8 coordinate points

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "success",
    "data": {"channel_info": {"CH1": {
        "status": "Online",
        "switch": false,
        "rule_info": {"rule_number1": {
            "rule_switch": true,
            "rule_rect": {
                "x1": 0,
                "y1": 0,
                "x2": 704,
                "y2": 0,
                "x3": 704,
                "y3": 576,
                "x4": 0,
                "y4": 576
            }
        }}
    }}}
}

Error Code

See Response Messages Body and Common error_code for more information.